Skip to content

Exclude contrib/ from build#1753

Closed
StanFromIreland wants to merge 2 commits intopython:mainfrom
StanFromIreland:exclude-contrib
Closed

Exclude contrib/ from build#1753
StanFromIreland wants to merge 2 commits intopython:mainfrom
StanFromIreland:exclude-contrib

Conversation

@StanFromIreland
Copy link
Member

@StanFromIreland StanFromIreland commented Mar 3, 2026

From the new analytics, it is clear a significant portion of (non-version page) readers are ending up on these pages, I would assume primarily because they appear in search results. As such, I suggest disabling building them.

@StanFromIreland StanFromIreland requested a review from nedbat March 3, 2026 19:04
@read-the-docs-community
Copy link

Documentation build overview

📚 CPython devguide | 🛠️ Build #31648720 | 📁 Comparing ee3840a against latest (9537d3d)


🔍 Preview build

Show files changed (52 files in total): 📝 2 modified | ➕ 0 added | ➖ 50 deleted
File Status
index.html 📝 modified
contrib/index.html ➖ deleted
genindex/index.html 📝 modified
contrib/code/index.html ➖ deleted
contrib/contrib-plan/index.html ➖ deleted
contrib/core-team/index.html ➖ deleted
contrib/doc/index.html ➖ deleted
contrib/intro/index.html ➖ deleted
contrib/project/index.html ➖ deleted
contrib/security/index.html ➖ deleted
contrib/triage/index.html ➖ deleted
contrib/user-success/index.html ➖ deleted
contrib/workflows/index.html ➖ deleted
contrib/code/developer-workflow/index.html ➖ deleted
contrib/code/development-tools/index.html ➖ deleted
contrib/code/git/index.html ➖ deleted
contrib/code/pull-request-lifecycle/index.html ➖ deleted
contrib/code/setup/index.html ➖ deleted
contrib/code/testing/index.html ➖ deleted
contrib/core-team/committing/index.html ➖ deleted
contrib/core-team/experts/index.html ➖ deleted
contrib/core-team/join-team/index.html ➖ deleted
contrib/core-team/motivations/index.html ➖ deleted
contrib/core-team/responsibilities/index.html ➖ deleted
contrib/core-team/team-log/index.html ➖ deleted
contrib/doc/devguide/index.html ➖ deleted
contrib/doc/help-documenting/index.html ➖ deleted
contrib/doc/markup/index.html ➖ deleted
contrib/doc/pull-request-lifecycle/index.html ➖ deleted
contrib/doc/start-documenting/index.html ➖ deleted
contrib/doc/style-guide/index.html ➖ deleted
contrib/doc/translating/index.html ➖ deleted
contrib/project/channels/index.html ➖ deleted
contrib/project/conduct/index.html ➖ deleted
contrib/project/directory-structure/index.html ➖ deleted
contrib/project/generative-ai/index.html ➖ deleted
contrib/project/github/index.html ➖ deleted
contrib/project/governance/index.html ➖ deleted
contrib/project/outreach/index.html ➖ deleted
contrib/project/roles/index.html ➖ deleted
contrib/triage/issue-tracker/index.html ➖ deleted
contrib/triage/labels/index.html ➖ deleted
contrib/triage/reviewing/index.html ➖ deleted
contrib/triage/triage-team/index.html ➖ deleted
contrib/triage/triaging/index.html ➖ deleted
contrib/workflows/codespaces/index.html ➖ deleted
contrib/workflows/compile/index.html ➖ deleted
contrib/workflows/get-source/index.html ➖ deleted
contrib/workflows/install-dependencies/index.html ➖ deleted
contrib/workflows/install-git/index.html ➖ deleted
contrib/workflows/regenerate/index.html ➖ deleted
contrib/workflows/troubleshooting/index.html ➖ deleted

@encukou
Copy link
Member

encukou commented Mar 4, 2026

Do we need redirects to send these people to the right place?

Is skipping these meaningfully different from removing the content from the main branch entirely?

@StanFromIreland
Copy link
Member Author

Do we need redirects to send these people to the right place?

I don't think so, people shouldn't have created links to the contrib pages. The sources on the Analytics are all search engines.

I would like to keep it, for now at least, possibly condensing it into a single file.

@encukou
Copy link
Member

encukou commented Mar 4, 2026

The sources on the Analytics are all search engines.

Shouldn't we make the search engines send people to the right place?

possibly condensing it into a single file.

I'd much prefer that instead of removing contrib. Let's not clean the room by shoving things under the bed.

@hugovk
Copy link
Member

hugovk commented Mar 4, 2026

I don't think so, people shouldn't have created links to the contrib pages. The sources on the Analytics are all search engines.

What sort of numbers are we looking at?

/contrib/* was always intended to be temporary and removed eventually.

@StanFromIreland
Copy link
Member Author

StanFromIreland commented Mar 4, 2026

What sort of numbers are we looking at?

Today, up to now, there were 2100 unique visitors. 1500 of whom visited the version page, this will skew all statistics, so I exclude it. This leaves 600, for reference, 265 of these visited the index (~44%), and 80 visited a /contrib/ page (~13%).

@encukou
Copy link
Member

encukou commented Mar 4, 2026

Here's a PR to remove the directory from main: #1757

Given that the source stays in git, this would have the same effect as excluding it from the build. Either way, we can no longer see the rendered version onling.

@encukou encukou mentioned this pull request Mar 4, 2026
@StanFromIreland StanFromIreland deleted the exclude-contrib branch March 4, 2026 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants